Introduce a common glossary file - #2
Conversation
| storage, calls, events and errors. A runtime is composed of pallets | ||
| (`pallet-balances`, `pallet-staking`, …). | ||
|
|
||
| **Runtime API** — A versioned interface (`sp-api`) the Wasm runtime exposes |
| **System chain** — A parachain that is part of the network's protocol itself. | ||
| Runs on behalf of the network; its runtime lives in the *Fellowship | ||
| runtimes*. Uses a para ID below 2000 — the range that is not publicly | ||
| registrable (`LOWEST_PUBLIC_ID` in polkadot-sdk). |
There was a problem hiding this comment.
also here link would be nice.
I think we should cross-link whenever possible (fixed commit not master).
bkchr
left a comment
There was a problem hiding this comment.
Please make them more "on the point". E.g. "node" is repeating itself and tries to convey too much information that is totally unneeded "The binary running a chain: networking, database, consensus, RPC." is more than enough to get you started.
| gated by an authorization model — | ||
| an account is authorized in advance to upload, and authorizations expire. | ||
| Data is uploaded by submitting extrinsics; the uploaded data itself is kept | ||
| in off-chain storage, not in the runtime state, and has a retention period. |
There was a problem hiding this comment.
It's not kept in runtime state but it is kept by all collators. Important distinction to Web3 Storage where collators wouldn't keep any of the data
| validation, metadata, …). Not the node's JSON-RPC: RPC is served by the node | ||
| to external clients, a runtime API is called by the node into the runtime. | ||
|
|
||
| **SDK release** — A versioned release (`stableYYMM`) of |
There was a problem hiding this comment.
There are also patch releases
| **Fellowship runtimes** — The production runtimes of Polkadot, Kusama and | ||
| their *system chains*, maintained by the Polkadot Technical Fellowship in |
There was a problem hiding this comment.
| **Fellowship runtimes** — The production runtimes of Polkadot, Kusama and | |
| their *system chains*, maintained by the Polkadot Technical Fellowship in | |
| **Fellowship runtimes** — The production runtimes of Polkadot and Kusama, maintained by the Polkadot Technical Fellowship in |
|
|
||
| --- | ||
|
|
||
| **Bulletin** — The Polkadot Bulletin chain |
There was a problem hiding this comment.
| **Bulletin** — The Polkadot Bulletin chain | |
| **Levity** (a.k.a Bulletin) — The Polkadot Bulletin chain |
The PR proposes a place for common terminology, dictionary-style. Technical docs should strive to use common nomenclature to reduce ambiguity - ideally could be AI-friendly to provide a quality context for AI-assisted research
File is named GLOSSARY.md and placed at the root of the repo but its just the initial idea - opening this PR with some examples for discussion